home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / bbsfax10.zip / BBSFAX.DOC < prev    next >
Text File  |  1992-01-21  |  13KB  |  463 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.                                      BBSFAX V1.0
  27.  
  28.                       Copyright (c) 1992 Richard D. Fothergill
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.                                                       Richard D. Fothergill
  57.                                                            the Oak Hill BBS
  58.                                                           141 Oak Hill Road
  59.                                                       Pittsfield, MA  01201
  60.                                                   Data/FAX - (413) 499-7245
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.           WHAT IS BBSFAX?
  74.  
  75.           When  I purchased my ZyXEL  U-1496 Modem/Fax I wanted an easy way
  76.           to  be able to accept fax and modem calls on the same line.  This
  77.           would  allow me to continue to operate my BBS software as well as
  78.           be  in a  position  to receive  faxes.   I tried  BinkleyTerm and
  79.           FrontDoor.   Both excellent programs,  but way more than I needed
  80.           or  wanted, not having  a need for  network mailers nor needing a
  81.           built  in terminal  program.  I  wanted something  simple, small,
  82.           easy to setup and maintain.  Thus the beginning of BBSFAX.
  83.  
  84.           WHAT CAN I DO WITH BBSFAX?
  85.  
  86.           You  run BBSFAX instead of your BBS software.  BBSFAX will answer
  87.           the  phone, determine what the  incoming call is and exit with an
  88.           errorlevel  which  you  can  use in  a  batch  file  to determine
  89.           subsequent  operations.  In the  case of a  BBS call it will also
  90.           create  a batch file to  call your BBS software.  In addition you
  91.           can  program up to 10  events with a preset time of execution and
  92.           exit  errorlevel.  When  BBSFAX encounters  one of  these it will
  93.           exit  with  your predetermined  errorlevel.   Again,  you control
  94.           further processing in your batch file.
  95.  
  96.           REQUIREMENTS
  97.  
  98.           BBSFAX must have a FOSSIL driver loaded.  It has been tested with
  99.           both BNU and X00.  Either one will work.
  100.  
  101.           DISCLAIMER
  102.  
  103.           IN  NO EVENT WILL  I BE LIABLE  TO YOU FOR ANY DAMAGES, INCLUDING
  104.           ANY   LOST  PROFITS,   LOST  SAVINGS   OR  OTHER   INCIDENTAL  OR
  105.           CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE
  106.           THE PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY.
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.           BBSFAX V1.0                                   -1-
  129.           Copr (c) 1992 Richard D. Fothergill
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.           INSTALLATION
  140.  
  141.           There  are three files that  must be created to run BBSFAX.  They
  142.           are  BBS.BAT, BBSFAX.CFG,  BBSFAX.EVT.  I  will discuss  each one
  143.           individually.
  144.  
  145.           BBS.BAT
  146.  
  147.           This batch file is the heart of your BBS/FAX system.  It controls
  148.           all  activity and  execution.  You  do not  have to  use the name
  149.           BBS.BAT,  it can be any  name of your choosing.  The following is
  150.           the BBS.BAT file I use.
  151.  
  152.           @ECHO OFF
  153.           bnu /R=3072 /T=1024 /L:1=38400,8N1 /F
  154.           :loop
  155.             cls
  156.             bbsfax
  157.             if errorlevel 40 goto event
  158.             if errorlevel 30 goto fax
  159.             if errorlevel 20 goto spit
  160.             if errorlevel 10 goto spitl
  161.             if errorlevel  0 goto end
  162.           :event
  163.              call sfmaint
  164.              goto loop
  165.           :fax
  166.             rcvfax 1 f:\sf\fax
  167.             goto loop
  168.           :spit
  169.             call bbsexe
  170.             goto loop
  171.           :spitl
  172.             spitfire 0
  173.             goto loop
  174.           :end
  175.           bnu /u
  176.  
  177.           There are four hardcoded errorlevels.  They are:
  178.  
  179.                0 - Terminate
  180.               10 - Local Logon
  181.               20 - BBS/Modem Connection
  182.               30 - FAX Connection
  183.  
  184.           BNU is loaded at the start of the batch file.  The loop: label is
  185.           where  execution  of the  batch  file  will return  to  after any
  186.           activity  other than a normal exit.  BBSFAX is started and awaits
  187.           a  caller.  If  a call  is received  or a  scheduled event occurs
  188.           BBSFAX will exit with the corresponding errorlevel.  Control then
  189.           returns to this batch file.  This is relatively straight forward.
  190.  
  191.  
  192.  
  193.  
  194.           BBSFAX V1.0                                   -2-
  195.           Copr (c) 1992 Richard D. Fothergill
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.           BBSFAX.CFG
  206.  
  207.           This  is the  configuration file  you setup  to inform  BBSFAX of
  208.           certain  parameters it  needs to  function.   The following  is a
  209.           sample configuration file.
  210.  
  211.           CM=2
  212.           MI=ATZM0V1E0S2=1X7#B1+FCLASS=6
  213.           AS=ATA
  214.           MO=ATH1
  215.           MR=ATZ
  216.           BB=SPITFIRE
  217.           CP=/C
  218.           ST=120
  219.           RC=2
  220.  
  221.           There  are no spaces  allowed in this  file between the parameter
  222.           and  the = sign.  The  items should appear in the sequence listed
  223.           and  each parameter  must have  a value.   The parameters and the
  224.           meanings are a follows:
  225.  
  226.           CM  The communications port you have your modem on.
  227.  
  228.           MI  Your modem initialization string.  This should be for both
  229.               modem and fax reception.
  230.  
  231.           AS  Modem answer string.
  232.  
  233.           MO  Modem offhook string.
  234.  
  235.           MR  Modem reset string.  This is sent to the modem upon normal
  236.               termination.
  237.  
  238.           BB  The name you would like placed in the BBSEXE.BAT file.
  239.  
  240.           CP  The text you would like to preceed the com port parameter in
  241.               the BBSEXE.BAT file.  Spitfire specifies that the parameter
  242.               read /C<comport>.  Check your BBS software.
  243.  
  244.           ST  Sleep time out seconds.  This is the amount of time BBSFAX
  245.               will wait before blanking the screen.  A display of the
  246.               program name and current time will appear at random locations
  247.               to remind you of the program running.  If ST=0 then screen
  248.               blanking is disabled.
  249.  
  250.           RC  The number of rings on which you would like BBSFAX to answer
  251.               the call.
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.           BBSFAX V1.0                                   -3-
  261.           Copr (c) 1992 Richard D. Fothergill
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.           BBSFAX.EVT
  272.  
  273.           This file is used to define your events.  It is a comma delimited
  274.           file consisting of three parameters.  The first is a 40 character
  275.           description.  This will be written to the log file when the event
  276.           is executed.  The second is the time you want the event to occur.
  277.           The format is HH:MM and is in 24 hour time.  The last item is the
  278.           errorlevel.   This can be  any value except  one of the hardcoded
  279.           errorlevels  mentioned  earlier.   Each event  must  appear  on a
  280.           separate  line in the  file and you  are limited to 10 events.  A
  281.           typical line in the event file is as follows:
  282.  
  283.               DAILY MAINTENANCE,01:00,40
  284.  
  285.           This  line would cause BBSFAX to exit with an errorlevel of 40 at
  286.           1:00 am.
  287.  
  288.           FILES CREATED BY BBSFAX
  289.  
  290.           There  are three files  created by BBSFAX.   A discussion of each
  291.           follows.
  292.  
  293.           BBSFAX.LOG
  294.  
  295.           If  this file is not  found at start-up BBSFAX creates a new one.
  296.           Each  time an activity occurs,  an entry is written to this file.
  297.           The entry will consist of the date, time, description of activity
  298.           and  either the errorlevel for an event or the CONNECT string for
  299.           a  modem connection.  Local logons  are not recorded in the file.
  300.           This  file has  no interaction with  your BBS  log file.  A modem
  301.           connection  may be made  and control passed  to your BBS software
  302.           and  the user might  hang up with  out logging on.  In this case,
  303.           there would still be a record of the connection in the BBSFAX.LOG
  304.           but in all probability, not in your BBS log.
  305.  
  306.           BBSFAX.STS
  307.  
  308.           This  is  a  file  used strictly  by  BBSFAX.   Each  time BBSFAX
  309.           releases  control back to DOS, BBSFAX writes control data to this
  310.           file.  When it restarts it reads this information back in.
  311.  
  312.           Although  not required, it is  suggested that each time you erase
  313.           the  BBSFAX.LOG file to clear that, you erase BBSFAX.STS to reset
  314.           the  call  statistics at  the  same  time.  You  do  not  have to
  315.           recreate  these files.  BBSFAX  will create  new ones if existing
  316.           files are not found.
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.           BBSFAX V1.0                                   -4-
  327.           Copr (c) 1992 Richard D. Fothergill
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.           EXEBBS.BAT
  338.  
  339.           When  a BBS  call is  received, BBSFAX  will create  a batch file
  340.           which  contains the name you  assigned to the BB parameter in the
  341.           configuration file, followed by the baud rate as parameter 1, the
  342.           CP  string  and CM  value you entered  in the configuration file.
  343.           The  parameters you specify  in the configuration file will allow
  344.           you to construct an entry that should allow you to start your BBS
  345.           software.  A typical entry in EXEBBS.BAT reads a follows:
  346.  
  347.               SPITFIRE 1200 /C2
  348.  
  349.           In  your BBS.BAT  file  you can  call  EXEBBS to  start  your BBS
  350.           software.
  351.  
  352.           GENERAL DISCUSSION
  353.  
  354.           As  you can  see  from my  sample  BBS.BAT file  I  am set  up as
  355.           follows.
  356.  
  357.           Errorlevel                Action
  358.               0         Normal program exit.  Modem reset.
  359.  
  360.              10         Local logon to BBS.  Spitfire requires that you
  361.                         call it with a baud rate of 0 to let it know that
  362.                         it is a local log on and not try to detect a
  363.                         carrier.
  364.  
  365.              20         Remote call BBS logon.  Spitfire requires that you
  366.                         call it with a baud rate and com port to notify it
  367.                         that a connection has already been made and to
  368.                         proceed to the user log on.
  369.  
  370.              30         Remote call FAX transmission.  The batch file
  371.                         passes control to ZyXEL's RCVFAX program which also
  372.                         assumes a connection has been established.
  373.  
  374.              40         User specified event.  I have this set to occur at
  375.                         1:00 am.  This is routine BBS maintenance.  Please
  376.                         remember, running in a system such a this, in all
  377.                         probability events scheduled in your BBS software
  378.                         will never occur.  Your BBS software is not the
  379.                         program controlling the flow, BBSFAX is, so events
  380.                         should be schedule through BBSFAX.
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.           BBSFAX V1.0                                   -5-
  393.           Copr (c) 1992 Richard D. Fothergill
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.           MENU AND HOT KEYS
  404.  
  405.           From  the Waiting  for Caller  screen you  have two  possible key
  406.           strokes.   Alt-X will  close BBSFAX  and  execute a  normal exit.
  407.           Alt-M  will bring  up a  pop menu  with the  following selections
  408.           available:
  409.  
  410.               View Activity Log
  411.               Local Logon
  412.               Drop to DOS
  413.               Terminate BBSFAX
  414.  
  415.           Within  this  menu  your  mouse  will  be  active  to  locate the
  416.           highlight  bar or you  can use the  arrow keys.  Either press the
  417.           left mouse button or the enter key to make a selection.  Pressing
  418.           the  right mouse  button or  the Esc  key will  return you to the
  419.           Waiting for Caller screen.
  420.  
  421.           View  Activity Log  - This  selection  will pop  up a  window and
  422.           display  the BBSFAX.LOG file.   All the direction keys are active
  423.           as  well as  the mouse.   Press the  Esc key  or the  right mouse
  424.           button to return to the menu.
  425.  
  426.           Local Logon - This will exit the system with an errorlevel of 10.
  427.           This  does not  have to  be a  local log  on.  You  can have your
  428.           BBS.BAT file execute any program you wish or none at all.
  429.  
  430.           Drop  to DOS  - Self explanatory.   The DOS  prompt is amended to
  431.           remind you to EXIT back to the BBSFAX menu.
  432.  
  433.           Terminate  BBSFAX -  Same  as the  Alt-X  key press.   Executes a
  434.           normal exit back to dos.
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.           BBSFAX V1.0                                   -6-
  459.           Copr (c) 1992 Richard D. Fothergill
  460.  
  461.  
  462.  
  463.